From e9b5fd5cf5e20fff511df704b6324bc6ede19159 Mon Sep 17 00:00:00 2001 From: Alexander Zaslonov Date: Thu, 24 Oct 2024 17:32:08 -0700 Subject: [PATCH] Added version 2024-06-01-preview for Azure API Center resource manager API. --- .../ApiCenter.Management/ApiSource.tsp | 47 + .../ApiCenter.Management/Service.tsp | 9 + .../ApiDefinitions_CreateOrUpdate.json | 60 + .../ApiDefinitions_Delete.json | 18 + .../ApiDefinitions_ExportSpecification.json | 27 + .../ApiDefinitions_Get.json | 35 + .../ApiDefinitions_Head.json | 21 + .../ApiDefinitions_ImportSpecification.json | 30 + .../ApiDefinitions_List.json | 38 + .../ApiSources_CreateOrUpdate.json | 59 + .../2024-06-01-preview/ApiSources_Delete.json | 16 + .../2024-06-01-preview/ApiSources_Get.json | 32 + .../2024-06-01-preview/ApiSources_Head.json | 19 + .../2024-06-01-preview/ApiSources_List.json | 35 + .../ApiVersions_CreateOrUpdate.json | 51 + .../ApiVersions_Delete.json | 17 + .../2024-06-01-preview/ApiVersions_Get.json | 30 + .../2024-06-01-preview/ApiVersions_Head.json | 20 + .../2024-06-01-preview/ApiVersions_List.json | 33 + .../Apis_CreateOrUpdate.json | 101 + .../2024-06-01-preview/Apis_Delete.json | 16 + .../examples/2024-06-01-preview/Apis_Get.json | 46 + .../2024-06-01-preview/Apis_Head.json | 19 + .../2024-06-01-preview/Apis_List.json | 49 + .../DeletedServices_Delete.json | 14 + .../DeletedServices_Get.json | 23 + .../DeletedServices_List.json | 26 + .../DeletedServices_ListBySubscription.json | 26 + .../Deployments_CreateOrUpdate.json | 75 + .../Deployments_Delete.json | 17 + .../2024-06-01-preview/Deployments_Get.json | 38 + .../2024-06-01-preview/Deployments_Head.json | 20 + .../2024-06-01-preview/Deployments_List.json | 41 + .../Environments_CreateOrUpdate.json | 89 + .../Environments_Delete.json | 16 + .../2024-06-01-preview/Environments_Get.json | 37 + .../2024-06-01-preview/Environments_Head.json | 19 + .../2024-06-01-preview/Environments_List.json | 41 + .../MetadataSchemas_CreateOrUpdate.json | 65 + .../MetadataSchemas_Delete.json | 15 + .../MetadataSchemas_Get.json | 33 + .../MetadataSchemas_Head.json | 18 + .../MetadataSchemas_List.json | 36 + .../2024-06-01-preview/Operations_List.json | 25 + .../Services_CreateOrUpdate.json | 69 + .../2024-06-01-preview/Services_Delete.json | 14 + .../Services_ExportMetadataSchema.json | 27 + .../2024-06-01-preview/Services_Get.json | 35 + .../Services_ImportFromApim.json | 29 + .../Services_ListByResourceGroup.json | 38 + .../Services_ListBySubscription.json | 38 + .../2024-06-01-preview/Services_Update.json | 44 + .../Workspaces_CreateOrUpdate.json | 46 + .../2024-06-01-preview/Workspaces_Delete.json | 15 + .../2024-06-01-preview/Workspaces_Get.json | 27 + .../2024-06-01-preview/Workspaces_Head.json | 18 + .../2024-06-01-preview/Workspaces_List.json | 30 + .../apicenter/ApiCenter.Management/main.tsp | 22 +- .../apicenter/ApiCenter.Management/models.tsp | 119 +- .../preview/2024-03-15-preview/apicenter.json | 52 + .../preview/2024-06-01-preview/apicenter.json | 5570 +++++++++++++++++ .../ApiDefinitions_CreateOrUpdate.json | 60 + .../examples/ApiDefinitions_Delete.json | 18 + .../ApiDefinitions_ExportSpecification.json | 27 + .../examples/ApiDefinitions_Get.json | 35 + .../examples/ApiDefinitions_Head.json | 21 + .../ApiDefinitions_ImportSpecification.json | 30 + .../examples/ApiDefinitions_List.json | 38 + .../examples/ApiSources_CreateOrUpdate.json | 59 + .../examples/ApiSources_Delete.json | 16 + .../examples/ApiSources_Get.json | 32 + .../examples/ApiSources_Head.json | 19 + .../examples/ApiSources_List.json | 35 + .../examples/ApiVersions_CreateOrUpdate.json | 51 + .../examples/ApiVersions_Delete.json | 17 + .../examples/ApiVersions_Get.json | 30 + .../examples/ApiVersions_Head.json | 20 + .../examples/ApiVersions_List.json | 33 + .../examples/Apis_CreateOrUpdate.json | 101 + .../examples/Apis_Delete.json | 16 + .../2024-06-01-preview/examples/Apis_Get.json | 46 + .../examples/Apis_Head.json | 19 + .../examples/Apis_List.json | 49 + .../examples/DeletedServices_Delete.json | 14 + .../examples/DeletedServices_Get.json | 23 + .../examples/DeletedServices_List.json | 26 + .../DeletedServices_ListBySubscription.json | 26 + .../examples/Deployments_CreateOrUpdate.json | 75 + .../examples/Deployments_Delete.json | 17 + .../examples/Deployments_Get.json | 38 + .../examples/Deployments_Head.json | 20 + .../examples/Deployments_List.json | 41 + .../examples/Environments_CreateOrUpdate.json | 89 + .../examples/Environments_Delete.json | 16 + .../examples/Environments_Get.json | 37 + .../examples/Environments_Head.json | 19 + .../examples/Environments_List.json | 41 + .../MetadataSchemas_CreateOrUpdate.json | 65 + .../examples/MetadataSchemas_Delete.json | 15 + .../examples/MetadataSchemas_Get.json | 33 + .../examples/MetadataSchemas_Head.json | 18 + .../examples/MetadataSchemas_List.json | 36 + .../examples/Operations_List.json | 25 + .../examples/Services_CreateOrUpdate.json | 69 + .../examples/Services_Delete.json | 14 + .../Services_ExportMetadataSchema.json | 27 + .../examples/Services_Get.json | 35 + .../examples/Services_ImportFromApim.json | 29 + .../Services_ListByResourceGroup.json | 38 + .../examples/Services_ListBySubscription.json | 38 + .../examples/Services_Update.json | 44 + .../examples/Workspaces_CreateOrUpdate.json | 46 + .../examples/Workspaces_Delete.json | 15 + .../examples/Workspaces_Get.json | 27 + .../examples/Workspaces_Head.json | 18 + .../examples/Workspaces_List.json | 30 + .../stable/2024-03-01/apicenter.json | 52 + .../apicenter/resource-manager/readme.md | 11 +- 118 files changed, 9630 insertions(+), 4 deletions(-) create mode 100644 specification/apicenter/ApiCenter.Management/ApiSource.tsp create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ExportSpecification.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ImportSpecification.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_ListBySubscription.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Operations_List.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ExportMetadataSchema.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ImportFromApim.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListByResourceGroup.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListBySubscription.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Update.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_CreateOrUpdate.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Delete.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Get.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Head.json create mode 100644 specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/apicenter.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ExportSpecification.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ImportSpecification.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_ListBySubscription.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Operations_List.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ExportMetadataSchema.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ImportFromApim.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListByResourceGroup.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListBySubscription.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Update.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_CreateOrUpdate.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Delete.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Get.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Head.json create mode 100644 specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_List.json diff --git a/specification/apicenter/ApiCenter.Management/ApiSource.tsp b/specification/apicenter/ApiCenter.Management/ApiSource.tsp new file mode 100644 index 000000000000..8319c4cd4239 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/ApiSource.tsp @@ -0,0 +1,47 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; +import "./Workspace.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.ApiCenter; + +@added(Versions.v2024_06_01_preview) +@doc("API source entity.") +@parentResource(Workspace) +model ApiSource is ProxyResource { + @doc("The name of the API.") + @maxLength(90) + @minLength(1) + @pattern("^[a-zA-Z0-9-]{3,90}$") + @path + @key("apiSourceName") + @segment("apiSources") + name: string; +} + +@added(Versions.v2024_06_01_preview) +@armResourceOperations +interface ApiSources { + @doc("Returns details of the API source.") + get is ArmResourceRead; + @doc("Checks if specified API source exists.") + @head + head( + ...ResourceInstanceParameters< + ApiSource, + Foundations.BaseParameters + >, + ): OkResponse | ErrorResponse; + @doc("Creates new or updates existing API source.") + createOrUpdate is ArmResourceCreateOrReplaceSync; + @doc("Deletes specified API source.") + delete is ArmResourceDeleteSync; + @doc("Returns a collection of API sources.") + list is ArmResourceListByParent; +} diff --git a/specification/apicenter/ApiCenter.Management/Service.tsp b/specification/apicenter/ApiCenter.Management/Service.tsp index ca3d3bc50ed4..94cca2dfa9a3 100644 --- a/specification/apicenter/ApiCenter.Management/Service.tsp +++ b/specification/apicenter/ApiCenter.Management/Service.tsp @@ -6,6 +6,7 @@ import "./models.tsp"; using TypeSpec.Rest; using Azure.ResourceManager; using TypeSpec.Http; +using TypeSpec.Versioning; namespace Microsoft.ApiCenter; @doc("The service entity.") @@ -48,4 +49,12 @@ interface Services { MetadataSchemaExportRequest, MetadataSchemaExportResult >; + + @doc("Imports APIs from Azure API Management.") + @added(Versions.v2024_06_01_preview) + importFromApim is ArmResourceActionAsync< + Service, + ImportFromApimRequest, + ImportFromApimSuccessResult + >; } diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_CreateOrUpdate.json new file mode 100644 index 000000000000..8e6196d9f481 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "operationId": "ApiDefinitions_CreateOrUpdate", + "title": "ApiDefinitions_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "openapi", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "OpenAPI", + "description": "Default spec" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Delete.json new file mode 100644 index 000000000000..f639680ef8e0 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "ApiDefinitions_Delete", + "title": "ApiDefinitions_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ExportSpecification.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ExportSpecification.json new file mode 100644 index 000000000000..3821c5b27370 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ExportSpecification.json @@ -0,0 +1,27 @@ +{ + "operationId": "ApiDefinitions_ExportSpecification", + "title": "ApiDefinitions_ExportSpecification", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "format": "inline", + "value": "{ ... }" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Get.json new file mode 100644 index 000000000000..310aab091534 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Get.json @@ -0,0 +1,35 @@ +{ + "operationId": "ApiDefinitions_Get", + "title": "ApiDefinitions_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Head.json new file mode 100644 index 000000000000..38be8965d8a5 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_Head.json @@ -0,0 +1,21 @@ +{ + "operationId": "ApiDefinitions_Head", + "title": "ApiDefinitions_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ImportSpecification.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ImportSpecification.json new file mode 100644 index 000000000000..e5b9fc19fee7 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_ImportSpecification.json @@ -0,0 +1,30 @@ +{ + "operationId": "ApiDefinitions_ImportSpecification", + "title": "ApiDefinitions_ImportSpecification", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview", + "payload": { + "format": "link", + "value": "https://...", + "specification": { + "name": "openapi", + "version": "3.0.1" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_List.json new file mode 100644 index 000000000000..04153e2eaf5b --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiDefinitions_List.json @@ -0,0 +1,38 @@ +{ + "operationId": "ApiDefinitions_List", + "title": "ApiDefinitions_ListByApiVersion", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_CreateOrUpdate.json new file mode 100644 index 000000000000..a23ee34372a2 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "operationId": "ApiSources_CreateOrUpdate", + "title": "ApiSources_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview", + "resource": { + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Delete.json new file mode 100644 index 000000000000..d91435f5223b --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "ApiSources_Delete", + "title": "ApiSources_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Get.json new file mode 100644 index 000000000000..43267d3cda65 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Get.json @@ -0,0 +1,32 @@ +{ + "operationId": "ApiSources_Get", + "title": "ApiSources_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Head.json new file mode 100644 index 000000000000..3ff2902a3cfe --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "ApiSources_Head", + "title": "ApiSources_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_List.json new file mode 100644 index 000000000000..3e9148d8e2fc --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiSources_List.json @@ -0,0 +1,35 @@ +{ + "operationId": "ApiSources_List", + "title": "ApiSources_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_CreateOrUpdate.json new file mode 100644 index 000000000000..11d685148fd1 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "operationId": "ApiVersions_CreateOrUpdate", + "title": "ApiVersions_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Delete.json new file mode 100644 index 000000000000..d8ef640547e7 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "ApiVersions_Delete", + "title": "ApiVersions_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Get.json new file mode 100644 index 000000000000..7ccc2967ceea --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Get.json @@ -0,0 +1,30 @@ +{ + "operationId": "ApiVersions_Get", + "title": "ApiVersions_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Head.json new file mode 100644 index 000000000000..ffe65fb200ad --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_Head.json @@ -0,0 +1,20 @@ +{ + "operationId": "ApiVersions_Head", + "title": "ApiVersions_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_List.json new file mode 100644 index 000000000000..d5b2c50029e3 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/ApiVersions_List.json @@ -0,0 +1,33 @@ +{ + "operationId": "ApiVersions_List", + "title": "ApiVersions_ListByApi", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_CreateOrUpdate.json new file mode 100644 index 000000000000..389af0578131 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "operationId": "Apis_CreateOrUpdate", + "title": "Apis_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Delete.json new file mode 100644 index 000000000000..aa7a6ee86277 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "Apis_Delete", + "title": "Apis_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Get.json new file mode 100644 index 000000000000..3a61e9abb1fd --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Get.json @@ -0,0 +1,46 @@ +{ + "operationId": "Apis_Get", + "title": "Apis_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Head.json new file mode 100644 index 000000000000..509a03573e64 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "Apis_Head", + "title": "Apis_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_List.json new file mode 100644 index 000000000000..219c88c1d100 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Apis_List.json @@ -0,0 +1,49 @@ +{ + "operationId": "Apis_List", + "title": "Apis_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Delete.json new file mode 100644 index 000000000000..d1c62c1379a6 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Delete.json @@ -0,0 +1,14 @@ +{ + "title": "DeletedServices_Delete", + "operationId": "DeletedServices_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources", + "deletedServiceName": "contoso" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Get.json new file mode 100644 index 000000000000..ddb64b6711ad --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_Get.json @@ -0,0 +1,23 @@ +{ + "title": "DeletedServices_Get", + "operationId": "DeletedServices_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources", + "deletedServiceName": "contoso" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "name": "contoso", + "type": "Microsoft.ApiCenter/deletedServices", + "properties": { + "softDeletionDate": "2024-03-01T22:15:58.348Z", + "scheduledPurgeDate": "2024-05-01T22:15:58.348Z" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_List.json new file mode 100644 index 000000000000..030a12540fd9 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_List.json @@ -0,0 +1,26 @@ +{ + "title": "DeletedServices_ListBySubscription", + "operationId": "DeletedServices_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "name": "contoso", + "type": "Microsoft.ApiCenter/deletedServices", + "properties": { + "softDeletionDate": "2024-03-01T22:15:58.348Z", + "scheduledPurgeDate": "2024-05-01T22:15:58.348Z" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_ListBySubscription.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_ListBySubscription.json new file mode 100644 index 000000000000..8e0f6d95ba45 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/DeletedServices_ListBySubscription.json @@ -0,0 +1,26 @@ +{ + "title": "DeletedServices_List", + "operationId": "DeletedServices_List", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "name": "contoso", + "type": "Microsoft.ApiCenter/deletedServices", + "properties": { + "softDeletionDate": "2024-03-01T22:15:58.348Z", + "scheduledPurgeDate": "2024-05-01T22:15:58.348Z" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_CreateOrUpdate.json new file mode 100644 index 000000000000..4faf4937b6c6 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_CreateOrUpdate.json @@ -0,0 +1,75 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "production", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "production", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Delete.json new file mode 100644 index 000000000000..38a836904741 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Get.json new file mode 100644 index 000000000000..92b990535d12 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "Deployments_Get", + "title": "Deployments_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Head.json new file mode 100644 index 000000000000..8002bc97fb88 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_Head.json @@ -0,0 +1,20 @@ +{ + "operationId": "Deployments_Head", + "title": "Deployments_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_List.json new file mode 100644 index 000000000000..207f249349ae --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Deployments_List.json @@ -0,0 +1,41 @@ +{ + "operationId": "Deployments_List", + "title": "Deployments_ListByApi", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Development", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_CreateOrUpdate.json new file mode 100644 index 000000000000..23bd4c08fbbc --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "operationId": "Environments_CreateOrUpdate", + "title": "Environments_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/environments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/environments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Delete.json new file mode 100644 index 000000000000..66eea3aa7ef2 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "Environments_Delete", + "title": "Environments_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Get.json new file mode 100644 index 000000000000..64e29b1bc4af --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Get.json @@ -0,0 +1,37 @@ +{ + "operationId": "Environments_Get", + "title": "Environments_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Public", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [] + }, + "onboarding": { + "developerPortalUri": [] + }, + "customProperties": {} + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Head.json new file mode 100644 index 000000000000..4683f68e3e5e --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "Environments_Head", + "title": "Environments_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_List.json new file mode 100644 index 000000000000..5f27f0e36105 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Environments_List.json @@ -0,0 +1,41 @@ +{ + "operationId": "Environments_List", + "title": "Environments_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [] + }, + "onboarding": { + "developerPortalUri": [] + }, + "customProperties": {} + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_CreateOrUpdate.json new file mode 100644 index 000000000000..fd8f3036db04 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "operationId": "MetadataSchemas_CreateOrUpdate", + "title": "MetadataSchemas_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "metadataSchemaName": "author", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Delete.json new file mode 100644 index 000000000000..e2a29fd50627 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "MetadataSchemas_Delete", + "title": "MetadataSchemas_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "author", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Get.json new file mode 100644 index 000000000000..7343cc0d9af4 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Get.json @@ -0,0 +1,33 @@ +{ + "operationId": "MetadataSchemas_Get", + "title": "MetadataSchemas_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "lastName", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Head.json new file mode 100644 index 000000000000..8e1547a601a0 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_Head.json @@ -0,0 +1,18 @@ +{ + "operationId": "MetadataSchemas_Head", + "title": "MetadataSchemas_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "author", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_List.json new file mode 100644 index 000000000000..de67904b474d --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/MetadataSchemas_List.json @@ -0,0 +1,36 @@ +{ + "operationId": "MetadataSchemas_List", + "title": "MetadataSchemas_ListByService", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Operations_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Operations_List.json new file mode 100644 index 000000000000..9f3cd174dfef --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "List Provider Operations", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ApiCenter/services/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.ApiCenter", + "resource": "services", + "operation": "Lists services", + "description": "Lists registered services" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_CreateOrUpdate.json new file mode 100644 index 000000000000..18cd690e4082 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "operationId": "Services_CreateOrUpdate", + "title": "Services_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview", + "resource": { + "properties": {}, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Delete.json new file mode 100644 index 000000000000..b3e88494bd6d --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "Services_Delete", + "title": "Services_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ExportMetadataSchema.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ExportMetadataSchema.json new file mode 100644 index 000000000000..594020f67661 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ExportMetadataSchema.json @@ -0,0 +1,27 @@ +{ + "operationId": "Services_ExportMetadataSchema", + "title": "Services_ExportMetadataSchema", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "assignedTo": "api", + "api-version": "2024-06-01-preview", + "payload": { + "assignedTo": "api" + } + }, + "responses": { + "200": { + "body": { + "format": "json-schema", + "value": "{\"type\":\"object\",\"properties\":{ ... }}" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Get.json new file mode 100644 index 000000000000..7409fd533af7 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Get.json @@ -0,0 +1,35 @@ +{ + "operationId": "Services_Get", + "title": "Services_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ImportFromApim.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ImportFromApim.json new file mode 100644 index 000000000000..fe7388dee05a --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ImportFromApim.json @@ -0,0 +1,29 @@ +{ + "operationId": "Services_ImportFromApim", + "title": "Services_ImportFromApim", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview", + "body": { + "sourceResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso/apis/echo-api" + ] + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "startTime": "2024-10-23T19:49:30.6298125+00:00", + "endTime": "2024-10-23T19:49:50.3781596+00:00" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListByResourceGroup.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListByResourceGroup.json new file mode 100644 index 000000000000..0f3cb4abcb27 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "operationId": "Services_ListByResourceGroup", + "title": "Services_ListByResourceGroup", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListBySubscription.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListBySubscription.json new file mode 100644 index 000000000000..4345d15ef235 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_ListBySubscription.json @@ -0,0 +1,38 @@ +{ + "operationId": "Services_ListBySubscription", + "title": "Services_ListBySubscription", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Update.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Update.json new file mode 100644 index 000000000000..e2b72ad9fadb --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Services_Update.json @@ -0,0 +1,44 @@ +{ + "operationId": "Services_Update", + "title": "Services_Update", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview", + "payload": { + "tags": {}, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_CreateOrUpdate.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_CreateOrUpdate.json new file mode 100644 index 000000000000..bf99b85e459b --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspaces_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "default" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Delete.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Delete.json new file mode 100644 index 000000000000..91b771e83d36 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Workspaces_Delete", + "title": "Workspaces_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Get.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Get.json new file mode 100644 index 000000000000..ae32244ce106 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Get.json @@ -0,0 +1,27 @@ +{ + "operationId": "Workspaces_Get", + "title": "Workspaces_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Head.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Head.json new file mode 100644 index 000000000000..d8873512ff48 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_Head.json @@ -0,0 +1,18 @@ +{ + "operationId": "Workspaces_Head", + "title": "Workspaces_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_List.json b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_List.json new file mode 100644 index 000000000000..e0a565e13226 --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/examples/2024-06-01-preview/Workspaces_List.json @@ -0,0 +1,30 @@ +{ + "operationId": "Workspaces_List", + "title": "Workspaces_ListByService", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/ApiCenter.Management/main.tsp b/specification/apicenter/ApiCenter.Management/main.tsp index e749f7a8185b..7940241fd371 100644 --- a/specification/apicenter/ApiCenter.Management/main.tsp +++ b/specification/apicenter/ApiCenter.Management/main.tsp @@ -12,6 +12,7 @@ import "./Workspace.tsp"; import "./Api.tsp"; import "./ApiVersion.tsp"; import "./ApiDefinition.tsp"; +import "./ApiSource.tsp"; import "./Deployment.tsp"; import "./Environment.tsp"; @@ -41,6 +42,11 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_03_15_preview: "2024-03-15-preview", + + @doc("Azure API Center 2024-06-01-preview") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_06_01_preview: "2024-06-01-preview", } #suppress "deprecated" "LEGACY - DO NOT COPY THIS DOESN'T MAKE SENSE - FIX" @@ -105,8 +111,6 @@ enum Versions { "payload" ); -@@clientName(ApiDefinitions.importSpecification::parameters.body, "payload"); - @@encodedName(ApiDefinitions.exportSpecification::parameters.body, "application/json", "payload" @@ -205,3 +209,17 @@ model ArmResponseWithEtag { ...Azure.Core.EtagResponseEnvelope; ...Body; } + +model IfMatchParameters { + @added(Versions.v2024_06_01_preview) + @doc("The request should only proceed if an entity matches this string.") + @header("If-Match") + ifMatch?: string; +} + +model IfNoneMatchParameters { + @added(Versions.v2024_06_01_preview) + @header("If-None-Match") + @doc("The request should only proceed if no entity matches this string.") + ifNoneMatch?: string; +} diff --git a/specification/apicenter/ApiCenter.Management/models.tsp b/specification/apicenter/ApiCenter.Management/models.tsp index a13fbb1561d6..5a85624f3ce1 100644 --- a/specification/apicenter/ApiCenter.Management/models.tsp +++ b/specification/apicenter/ApiCenter.Management/models.tsp @@ -1,6 +1,7 @@ import "@typespec/rest"; import "@typespec/http"; import "@typespec/openapi"; +import "@typespec/openapi3"; using TypeSpec.Rest; using TypeSpec.Http; @@ -266,6 +267,37 @@ model MetadataSchemaProperties { assignedTo?: MetadataAssignment[]; } +@added(Versions.v2024_06_01_preview) +@doc("The import from Azure API Management request.") +model ImportFromApimRequest { + @doc("An entity the metadata schema is requested for.") + sourceResourceIds?: string[]; +} + +@added(Versions.v2024_06_01_preview) +@doc("The import operation was successfully completed.") +model ImportFromApimSuccessResult { + /** + * The successful response status code. + */ + @statusCode code: 200; + + /** + * Async operation status. + */ + status: string; + + /** + * Async operation start time. + */ + startTime: utcDateTime; + + /** + * Async operation end time. + */ + endTime?: utcDateTime; +} + @doc("Assignment metadata") model MetadataAssignment { @doc("The entities this metadata schema component gets applied to.") @@ -487,7 +519,7 @@ model DeploymentProperties { customProperties?: CustomProperties; } -#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing service" @summary("Custom Properties") @doc("The custom metadata defined for API catalog entities.") model CustomProperties {} @@ -557,3 +589,88 @@ model DeletedServiceProperties { @doc("UTC date and time when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.") softDeletionDate?: utcDateTime; } + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Existing service" +@added(Versions.v2024_06_01_preview) +@doc("API source properties.") +model ApiSourceProperties { + @doc("Indicates if the specification should be imported along with metadata.") + shouldImportSpec?: ShouldImportSpec = ShouldImportSpec.OnDemand; + + @doc("API source configuration for Azure API Management.") + apimSource?: ApimSource; +} + +/** + * The API source specification import options. + */ +@added(Versions.v2024_06_01_preview) +union ShouldImportSpec { + string, + + /** + * Indicates that the specification should be never be imported. + */ + Never: "never", + + /** + * Indicates that the specification should be imported only by request. + */ + OnDemand: "ondemand", + + /** + * Indicates that the specification should always be imported along with metadata. + */ + Always: "always", +} + +/** + * API source configuration for Azure API Management. + */ +model ApimSource { + /** + * API Management service resource ID. + */ + resourceId: string; + + /** + * The resource ID of the managed identity that has access to the API Management instance. + */ + msiResourceId?: string; + + /** + * The target environment resource ID. + */ + targetEnvironmentId?: string; + + /** + * The target lifecycle stage. + */ + targetLifecycleStage?: LifecycleStage; + + /** + * The state of the API source link + */ + @visibility("read") + linkState?: LinkState; +} + +/** + * The link state. + */ +model LinkState { + /** + * The state of the link. + */ + state?: string; + + /** + * The state message. + */ + message?: string; + + /** + * The timestamp of the last update of the link state. + */ + lastUpdatedOn: utcDateTime; +} 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 1350ded5e5a8..3ea234d4eced 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 @@ -3954,6 +3954,36 @@ "lifecycleStage" ] }, + "ApimSource": { + "type": "object", + "description": "API source configuration for Azure API Management.", + "properties": { + "resourceId": { + "type": "string", + "description": "API Management service resource ID." + }, + "msiResourceId": { + "type": "string", + "description": "The resource ID of the managed identity that has access to the API Management instance." + }, + "targetEnvironmentId": { + "type": "string", + "description": "The target environment resource ID." + }, + "targetLifecycleStage": { + "$ref": "#/definitions/LifecycleStage", + "description": "The target lifecycle stage." + }, + "linkState": { + "$ref": "#/definitions/LinkState", + "description": "The state of the API source link", + "readOnly": true + } + }, + "required": [ + "resourceId" + ] + }, "Contact": { "type": "object", "description": "Contact information", @@ -4470,6 +4500,28 @@ ] } }, + "LinkState": { + "type": "object", + "description": "The link state.", + "properties": { + "state": { + "type": "string", + "description": "The state of the link." + }, + "message": { + "type": "string", + "description": "The state message." + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update of the link state." + } + }, + "required": [ + "lastUpdatedOn" + ] + }, "ManagedServiceIdentityType": { "type": "string", "description": "The type of managed service identity", diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/apicenter.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/apicenter.json new file mode 100644 index 000000000000..61d5da599366 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/apicenter.json @@ -0,0 +1,5570 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure API Center", + "version": "2024-06-01-preview", + "description": "Azure API Center Resource Provider.", + "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": "Services" + }, + { + "name": "DeletedServices" + }, + { + "name": "MetadataSchemas" + }, + { + "name": "Workspaces" + }, + { + "name": "Apis" + }, + { + "name": "ApiVersions" + }, + { + "name": "ApiDefinitions" + }, + { + "name": "ApiSources" + }, + { + "name": "Deployments" + }, + { + "name": "Environments" + } + ], + "paths": { + "/providers/Microsoft.ApiCenter/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 Provider Operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiCenter/deletedServices": { + "get": { + "operationId": "DeletedServices_ListBySubscription", + "tags": [ + "DeletedServices" + ], + "description": "Lists services within an Azure subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeletedServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletedServices_ListBySubscription": { + "$ref": "./examples/DeletedServices_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiCenter/services": { + "get": { + "operationId": "Services_ListBySubscription", + "tags": [ + "Services" + ], + "description": "Lists services within an Azure subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Services_ListBySubscription": { + "$ref": "./examples/Services_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/deletedServices": { + "get": { + "operationId": "DeletedServices_List", + "tags": [ + "DeletedServices" + ], + "description": "Lists soft-deleted services.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.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/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeletedServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletedServices_List": { + "$ref": "./examples/DeletedServices_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/deletedServices/{deletedServiceName}": { + "get": { + "operationId": "DeletedServices_Get", + "tags": [ + "DeletedServices" + ], + "description": "Returns details of the soft-deleted service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deletedServiceName", + "in": "path", + "description": "The name of the deleted service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeletedService" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletedServices_Get": { + "$ref": "./examples/DeletedServices_Get.json" + } + } + }, + "delete": { + "operationId": "DeletedServices_Delete", + "tags": [ + "DeletedServices" + ], + "description": "Permanently deletes specified service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deletedServiceName", + "in": "path", + "description": "The name of the deleted service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "DeletedServices_Delete": { + "$ref": "./examples/DeletedServices_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services": { + "get": { + "operationId": "Services_ListByResourceGroup", + "tags": [ + "Services" + ], + "description": "Returns a collection of services within the 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/ServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Services_ListByResourceGroup": { + "$ref": "./examples/Services_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}": { + "get": { + "operationId": "Services_Get", + "tags": [ + "Services" + ], + "description": "Returns details of the service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Services_Get": { + "$ref": "./examples/Services_Get.json" + } + } + }, + "put": { + "operationId": "Services_CreateOrUpdate", + "tags": [ + "Services" + ], + "description": "Creates new or updates existing API.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Service" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Service' update operation succeeded", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "201": { + "description": "Resource 'Service' create operation succeeded", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Services_CreateOrUpdate": { + "$ref": "./examples/Services_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "Services_Update", + "tags": [ + "Services" + ], + "description": "Updates existing service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceUpdate" + }, + "x-ms-client-name": "properties" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Services_Update": { + "$ref": "./examples/Services_Update.json" + } + } + }, + "delete": { + "operationId": "Services_Delete", + "tags": [ + "Services" + ], + "description": "Deletes specified service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "Services_Delete": { + "$ref": "./examples/Services_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/exportMetadataSchema": { + "post": { + "operationId": "Services_ExportMetadataSchema", + "tags": [ + "Services" + ], + "description": "Exports the effective metadata schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataSchemaExportRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetadataSchemaExportResult" + } + }, + "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": { + "Services_ExportMetadataSchema": { + "$ref": "./examples/Services_ExportMetadataSchema.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/importFromApim": { + "post": { + "operationId": "Services_ImportFromApim", + "tags": [ + "Services" + ], + "description": "Imports APIs from Azure API Management.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ImportFromApimRequest" + } + } + ], + "responses": { + "200": { + "description": "The import operation was successfully completed.", + "schema": { + "$ref": "#/definitions/ImportFromApimSuccessResult" + } + }, + "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": { + "Services_ImportFromApim": { + "$ref": "./examples/Services_ImportFromApim.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas": { + "get": { + "operationId": "MetadataSchemas_List", + "tags": [ + "MetadataSchemas" + ], + "description": "Returns a collection of metadata schemas.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetadataSchemaListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MetadataSchemas_ListByService": { + "$ref": "./examples/MetadataSchemas_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas/{metadataSchemaName}": { + "get": { + "operationId": "MetadataSchemas_Get", + "tags": [ + "MetadataSchemas" + ], + "description": "Returns details of the metadata schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetadataSchema" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MetadataSchemas_Get": { + "$ref": "./examples/MetadataSchemas_Get.json" + } + } + }, + "put": { + "operationId": "MetadataSchemas_CreateOrUpdate", + "tags": [ + "MetadataSchemas" + ], + "description": "Creates new or updates existing metadata schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataSchema" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'MetadataSchema' update operation succeeded", + "schema": { + "$ref": "#/definitions/MetadataSchema" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'MetadataSchema' create operation succeeded", + "schema": { + "$ref": "#/definitions/MetadataSchema" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MetadataSchemas_CreateOrUpdate": { + "$ref": "./examples/MetadataSchemas_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "MetadataSchemas_Delete", + "tags": [ + "MetadataSchemas" + ], + "description": "Deletes specified metadata schema.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "MetadataSchemas_Delete": { + "$ref": "./examples/MetadataSchemas_Delete.json" + } + } + }, + "head": { + "operationId": "MetadataSchemas_Head", + "tags": [ + "MetadataSchemas" + ], + "description": "Checks if specified metadata schema exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "metadataSchemaName", + "in": "path", + "description": "The name of the metadata schema.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MetadataSchemas_Head": { + "$ref": "./examples/MetadataSchemas_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces": { + "get": { + "operationId": "Workspaces_List", + "tags": [ + "Workspaces" + ], + "description": "Returns a collection of workspaces.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_ListByService": { + "$ref": "./examples/Workspaces_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}": { + "get": { + "operationId": "Workspaces_Get", + "tags": [ + "Workspaces" + ], + "description": "Returns details of the workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Workspace" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_Get": { + "$ref": "./examples/Workspaces_Get.json" + } + } + }, + "put": { + "operationId": "Workspaces_CreateOrUpdate", + "tags": [ + "Workspaces" + ], + "description": "Creates new or updates existing workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'Workspace' update operation succeeded", + "schema": { + "$ref": "#/definitions/Workspace" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'Workspace' create operation succeeded", + "schema": { + "$ref": "#/definitions/Workspace" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_CreateOrUpdate": { + "$ref": "./examples/Workspaces_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Workspaces_Delete", + "tags": [ + "Workspaces" + ], + "description": "Deletes specified workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "Workspaces_Delete": { + "$ref": "./examples/Workspaces_Delete.json" + } + } + }, + "head": { + "operationId": "Workspaces_Head", + "tags": [ + "Workspaces" + ], + "description": "Checks if specified workspace exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_Head": { + "$ref": "./examples/Workspaces_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apiSources": { + "get": { + "operationId": "ApiSources_List", + "tags": [ + "ApiSources" + ], + "description": "Returns a collection of API sources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiSourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiSources_ListByWorkspace": { + "$ref": "./examples/ApiSources_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apiSources/{apiSourceName}": { + "get": { + "operationId": "ApiSources_Get", + "tags": [ + "ApiSources" + ], + "description": "Returns details of the API source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiSourceName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiSource" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiSources_Get": { + "$ref": "./examples/ApiSources_Get.json" + } + } + }, + "put": { + "operationId": "ApiSources_CreateOrUpdate", + "tags": [ + "ApiSources" + ], + "description": "Creates new or updates existing API source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiSourceName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiSource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApiSource' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiSource" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'ApiSource' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiSource" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiSources_CreateOrUpdate": { + "$ref": "./examples/ApiSources_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "ApiSources_Delete", + "tags": [ + "ApiSources" + ], + "description": "Deletes specified API source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiSourceName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "ApiSources_Delete": { + "$ref": "./examples/ApiSources_Delete.json" + } + } + }, + "head": { + "operationId": "ApiSources_Head", + "tags": [ + "ApiSources" + ], + "description": "Checks if specified API source exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiSourceName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiSources_Head": { + "$ref": "./examples/ApiSources_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis": { + "get": { + "operationId": "Apis_List", + "tags": [ + "Apis" + ], + "description": "Returns a collection of APIs.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Apis_ListByWorkspace": { + "$ref": "./examples/Apis_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}": { + "get": { + "operationId": "Apis_Get", + "tags": [ + "Apis" + ], + "description": "Returns details of the API.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Api" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Apis_Get": { + "$ref": "./examples/Apis_Get.json" + } + } + }, + "put": { + "operationId": "Apis_CreateOrUpdate", + "tags": [ + "Apis" + ], + "description": "Creates new or updates existing API.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Api" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'Api' update operation succeeded", + "schema": { + "$ref": "#/definitions/Api" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'Api' create operation succeeded", + "schema": { + "$ref": "#/definitions/Api" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Apis_CreateOrUpdate": { + "$ref": "./examples/Apis_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Apis_Delete", + "tags": [ + "Apis" + ], + "description": "Deletes specified API.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "Apis_Delete": { + "$ref": "./examples/Apis_Delete.json" + } + } + }, + "head": { + "operationId": "Apis_Head", + "tags": [ + "Apis" + ], + "description": "Checks if specified API exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Apis_Head": { + "$ref": "./examples/Apis_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments": { + "get": { + "operationId": "Deployments_List", + "tags": [ + "Deployments" + ], + "description": "Returns a collection of API deployments.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_ListByApi": { + "$ref": "./examples/Deployments_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}": { + "get": { + "operationId": "Deployments_Get", + "tags": [ + "Deployments" + ], + "description": "Returns details of the API deployment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Get": { + "$ref": "./examples/Deployments_Get.json" + } + } + }, + "put": { + "operationId": "Deployments_CreateOrUpdate", + "tags": [ + "Deployments" + ], + "description": "Creates new or updates existing API deployment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'Deployment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'Deployment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_CreateOrUpdate": { + "$ref": "./examples/Deployments_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Deployments_Delete", + "tags": [ + "Deployments" + ], + "description": "Deletes API deployment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "Deployments_Delete": { + "$ref": "./examples/Deployments_Delete.json" + } + } + }, + "head": { + "operationId": "Deployments_Head", + "tags": [ + "Deployments" + ], + "description": "Checks if specified API deployment exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the API deployment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Head": { + "$ref": "./examples/Deployments_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions": { + "get": { + "operationId": "ApiVersions_List", + "tags": [ + "ApiVersions" + ], + "description": "Returns a collection of API versions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiVersions_ListByApi": { + "$ref": "./examples/ApiVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}": { + "get": { + "operationId": "ApiVersions_Get", + "tags": [ + "ApiVersions" + ], + "description": "Returns details of the API 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/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiVersion" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiVersions_Get": { + "$ref": "./examples/ApiVersions_Get.json" + } + } + }, + "put": { + "operationId": "ApiVersions_CreateOrUpdate", + "tags": [ + "ApiVersions" + ], + "description": "Creates new or updates existing API 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/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiVersion" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'ApiVersion' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiVersion" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'ApiVersion' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiVersion" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiVersions_CreateOrUpdate": { + "$ref": "./examples/ApiVersions_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "ApiVersions_Delete", + "tags": [ + "ApiVersions" + ], + "description": "Deletes specified API 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/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "ApiVersions_Delete": { + "$ref": "./examples/ApiVersions_Delete.json" + } + } + }, + "head": { + "operationId": "ApiVersions_Head", + "tags": [ + "ApiVersions" + ], + "description": "Checks if specified API version exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiVersions_Head": { + "$ref": "./examples/ApiVersions_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions": { + "get": { + "operationId": "ApiDefinitions_List", + "tags": [ + "ApiDefinitions" + ], + "description": "Returns a collection of API definitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiDefinitionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiDefinitions_ListByApiVersion": { + "$ref": "./examples/ApiDefinitions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}": { + "get": { + "operationId": "ApiDefinitions_Get", + "tags": [ + "ApiDefinitions" + ], + "description": "Returns details of the API definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiDefinition" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiDefinitions_Get": { + "$ref": "./examples/ApiDefinitions_Get.json" + } + } + }, + "put": { + "operationId": "ApiDefinitions_CreateOrUpdate", + "tags": [ + "ApiDefinitions" + ], + "description": "Creates new or updates existing API definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiDefinition" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'ApiDefinition' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiDefinition" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'ApiDefinition' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiDefinition" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiDefinitions_CreateOrUpdate": { + "$ref": "./examples/ApiDefinitions_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "ApiDefinitions_Delete", + "tags": [ + "ApiDefinitions" + ], + "description": "Deletes specified API definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "ApiDefinitions_Delete": { + "$ref": "./examples/ApiDefinitions_Delete.json" + } + } + }, + "head": { + "operationId": "ApiDefinitions_Head", + "tags": [ + "ApiDefinitions" + ], + "description": "Checks if specified API definition exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiDefinitions_Head": { + "$ref": "./examples/ApiDefinitions_Head.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/exportSpecification": { + "post": { + "operationId": "ApiDefinitions_ExportSpecification", + "tags": [ + "ApiDefinitions" + ], + "description": "Exports the API specification.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiSpecExportResult" + } + }, + "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": { + "ApiDefinitions_ExportSpecification": { + "$ref": "./examples/ApiDefinitions_ExportSpecification.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/importSpecification": { + "post": { + "operationId": "ApiDefinitions_ImportSpecification", + "tags": [ + "ApiDefinitions" + ], + "description": "Imports the API specification.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "apiName", + "in": "path", + "description": "The name of the API.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "versionName", + "in": "path", + "description": "The name of the API version.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "The name of the API definition.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ApiSpecImportRequest" + }, + "x-ms-client-name": "body" + } + ], + "responses": { + "200": { + "description": "The API specification was successfully imported." + }, + "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": { + "ApiDefinitions_ImportSpecification": { + "$ref": "./examples/ApiDefinitions_ImportSpecification.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments": { + "get": { + "operationId": "Environments_List", + "tags": [ + "Environments" + ], + "description": "Returns a collection of environments.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "$ref": "#/parameters/OdataFilterParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Environments_ListByWorkspace": { + "$ref": "./examples/Environments_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}": { + "get": { + "operationId": "Environments_Get", + "tags": [ + "Environments" + ], + "description": "Returns details of the environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Environments_Get": { + "$ref": "./examples/Environments_Get.json" + } + } + }, + "put": { + "operationId": "Environments_CreateOrUpdate", + "tags": [ + "Environments" + ], + "description": "Creates new or updates existing environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "payload", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "Resource 'Environment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "201": { + "description": "Resource 'Environment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The entity tag for the response." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Environments_CreateOrUpdate": { + "$ref": "./examples/Environments_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Environments_Delete", + "tags": [ + "Environments" + ], + "description": "Deletes the environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "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": { + "Environments_Delete": { + "$ref": "./examples/Environments_Delete.json" + } + } + }, + "head": { + "operationId": "Environments_Head", + "tags": [ + "Environments" + ], + "description": "Checks if specified environment exists.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of Azure API Center service.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "pattern": "^[a-zA-Z0-9-]{3,90}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Environments_Head": { + "$ref": "./examples/Environments_Head.json" + } + } + } + } + }, + "definitions": { + "ActionType": { + "type": "string", + "description": "The type of action", + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "name": "Internal", + "value": "Internal", + "description": "an internal action" + } + ] + } + }, + "Api": { + "type": "object", + "description": "API entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiDefinition": { + "type": "object", + "description": "API definition entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiDefinitionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiDefinitionListResult": { + "type": "object", + "description": "The response of a ApiDefinition list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApiDefinition items on this page", + "items": { + "$ref": "#/definitions/ApiDefinition" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "ApiDefinitionProperties": { + "type": "object", + "description": "API definition properties entity.", + "properties": { + "title": { + "type": "string", + "description": "API definition title.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "API definition description." + }, + "specification": { + "$ref": "#/definitions/ApiDefinitionPropertiesSpecification", + "description": "API specification details.", + "readOnly": true + } + }, + "required": [ + "title" + ] + }, + "ApiDefinitionPropertiesSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { + "type": "string", + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." + } + } + }, + "ApiImportSuccess": { + "type": "object", + "description": "The API specification was successfully imported." + }, + "ApiKind": { + "type": "string", + "description": "The kind of the API", + "enum": [ + "rest", + "graphql", + "grpc", + "soap", + "webhook", + "websocket" + ], + "x-ms-enum": { + "name": "ApiKind", + "modelAsString": true, + "values": [ + { + "name": "rest", + "value": "rest", + "description": "A Representational State Transfer Api" + }, + { + "name": "graphql", + "value": "graphql", + "description": "A Graph query language Api" + }, + { + "name": "grpc", + "value": "grpc", + "description": "A gRPC Api" + }, + { + "name": "soap", + "value": "soap", + "description": "A SOAP Api" + }, + { + "name": "webhook", + "value": "webhook", + "description": "Web Hook" + }, + { + "name": "websocket", + "value": "websocket", + "description": "Web Socket" + } + ] + } + }, + "ApiListResult": { + "type": "object", + "description": "The response of a Api list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Api items on this page", + "items": { + "$ref": "#/definitions/Api" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "ApiProperties": { + "type": "object", + "description": "API properties.", + "properties": { + "title": { + "type": "string", + "description": "API title.", + "minLength": 1, + "maxLength": 50 + }, + "kind": { + "$ref": "#/definitions/ApiKind", + "description": "Kind of API. For example, REST or GraphQL." + }, + "description": { + "type": "string", + "description": "Description of the API.", + "maxLength": 1000 + }, + "summary": { + "type": "string", + "description": "Short description of the API.", + "maxLength": 200 + }, + "lifecycleStage": { + "$ref": "#/definitions/LifecycleStage", + "description": "Current lifecycle stage of the API.", + "readOnly": true + }, + "termsOfService": { + "$ref": "#/definitions/TermsOfService", + "description": "Terms of service for the API." + }, + "externalDocumentation": { + "type": "array", + "description": "The set of external documentation", + "maxItems": 20, + "items": { + "$ref": "#/definitions/ExternalDocumentation" + }, + "x-ms-identifiers": [] + }, + "contacts": { + "type": "array", + "description": "The set of contacts", + "items": { + "$ref": "#/definitions/Contact" + }, + "x-ms-identifiers": [] + }, + "license": { + "$ref": "#/definitions/License", + "description": "The license information for the API." + }, + "customProperties": { + "$ref": "#/definitions/CustomProperties", + "description": "The custom metadata defined for API catalog entities." + } + }, + "required": [ + "title", + "kind" + ] + }, + "ApiSource": { + "type": "object", + "description": "API source entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiSourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiSourceListResult": { + "type": "object", + "description": "The response of a ApiSource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApiSource items on this page", + "items": { + "$ref": "#/definitions/ApiSource" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "ApiSourceProperties": { + "type": "object", + "description": "API source properties.", + "properties": { + "shouldImportSpec": { + "type": "string", + "description": "Indicates if the specification should be imported along with metadata.", + "default": "ondemand", + "enum": [ + "never", + "ondemand", + "always" + ], + "x-ms-enum": { + "name": "ShouldImportSpec", + "modelAsString": true, + "values": [ + { + "name": "Never", + "value": "never", + "description": "Indicates that the specification should be never be imported." + }, + { + "name": "OnDemand", + "value": "ondemand", + "description": "Indicates that the specification should be imported only by request." + }, + { + "name": "Always", + "value": "always", + "description": "Indicates that the specification should always be imported along with metadata." + } + ] + } + }, + "apimSource": { + "$ref": "#/definitions/ApimSource", + "description": "API source configuration for Azure API Management." + } + } + }, + "ApiSpecExportResult": { + "type": "object", + "description": "The API specification export result.", + "properties": { + "format": { + "$ref": "#/definitions/ApiSpecExportResultFormat", + "description": "The format of exported result" + }, + "value": { + "type": "string", + "description": "The result of the export operation." + } + } + }, + "ApiSpecExportResultFormat": { + "type": "string", + "description": "Result format for exported Api spec", + "enum": [ + "inline", + "link" + ], + "x-ms-enum": { + "name": "ApiSpecExportResultFormat", + "modelAsString": true, + "values": [ + { + "name": "inline", + "value": "inline", + "description": "The inlined content of a specification document." + }, + { + "name": "link", + "value": "link", + "description": "The link to the result of the export operation. The URL is valid for 5 minutes." + } + ] + } + }, + "ApiSpecImportRequest": { + "type": "object", + "description": "The API specification source entity properties.", + "properties": { + "value": { + "type": "string", + "description": "Value of the API specification source." + }, + "format": { + "$ref": "#/definitions/ApiSpecImportSourceFormat", + "description": "Format of the API specification source." + }, + "specification": { + "$ref": "#/definitions/ApiSpecImportRequestSpecification", + "description": "API specification details." + } + } + }, + "ApiSpecImportRequestSpecification": { + "type": "object", + "description": "API specification details.", + "properties": { + "name": { + "type": "string", + "description": "Specification name." + }, + "version": { + "type": "string", + "description": "Specification version." + } + } + }, + "ApiSpecImportSourceFormat": { + "type": "string", + "description": "Source format for imported Api spec", + "enum": [ + "inline", + "link" + ], + "x-ms-enum": { + "name": "ApiSpecImportSourceFormat", + "modelAsString": true, + "values": [ + { + "name": "inline", + "value": "inline", + "description": "The inlined content of a specification document." + }, + { + "name": "link", + "value": "link", + "description": "The link to a specification document hosted on a publicly accessible internet\naddress." + } + ] + } + }, + "ApiVersion": { + "type": "object", + "description": "API version entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApiVersionListResult": { + "type": "object", + "description": "The response of a ApiVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApiVersion items on this page", + "items": { + "$ref": "#/definitions/ApiVersion" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "ApiVersionProperties": { + "type": "object", + "description": "API version properties entity.", + "properties": { + "title": { + "type": "string", + "description": "API version title.", + "minLength": 1, + "maxLength": 50 + }, + "lifecycleStage": { + "$ref": "#/definitions/LifecycleStage", + "description": "Current lifecycle stage of the API." + } + }, + "required": [ + "title", + "lifecycleStage" + ] + }, + "ApimSource": { + "type": "object", + "description": "API source configuration for Azure API Management.", + "properties": { + "resourceId": { + "type": "string", + "description": "API Management service resource ID." + }, + "msiResourceId": { + "type": "string", + "description": "The resource ID of the managed identity that has access to the API Management instance." + }, + "targetEnvironmentId": { + "type": "string", + "description": "The target environment resource ID." + }, + "targetLifecycleStage": { + "$ref": "#/definitions/LifecycleStage", + "description": "The target lifecycle stage." + }, + "linkState": { + "$ref": "#/definitions/LinkState", + "description": "The state of the API source link", + "readOnly": true + } + }, + "required": [ + "resourceId" + ] + }, + "Contact": { + "type": "object", + "description": "Contact information", + "properties": { + "name": { + "type": "string", + "description": "Name of the contact.", + "maxLength": 100 + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL for the contact.", + "maxLength": 200 + }, + "email": { + "type": "string", + "description": "Email address of the contact.", + "maxLength": 100 + } + } + }, + "CreatedByType": { + "type": "string", + "description": "How the resource was created", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "CreatedByType", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Created by user" + }, + { + "name": "Application", + "value": "Application", + "description": "Created by Application" + }, + { + "name": "ManagedIdentity", + "value": "ManagedIdentity", + "description": "Created by Managed Identity" + }, + { + "name": "Key", + "value": "Key", + "description": "Created By Key" + } + ] + } + }, + "CustomProperties": { + "type": "object", + "title": "Custom Properties", + "description": "The custom metadata defined for API catalog entities." + }, + "DeletedService": { + "type": "object", + "description": "Soft-deleted service entity.", + "properties": { + "properties": { + "$ref": "#/definitions/DeletedServiceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DeletedServiceListResult": { + "type": "object", + "description": "The response of a DeletedService list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeletedService items on this page", + "items": { + "$ref": "#/definitions/DeletedService" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DeletedServiceProperties": { + "type": "object", + "description": "Deleted service properties.", + "properties": { + "scheduledPurgeDate": { + "type": "string", + "format": "date-time", + "description": "UTC date and time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "softDeletionDate": { + "type": "string", + "format": "date-time", + "description": "UTC date and time when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + } + } + }, + "Deployment": { + "type": "object", + "description": "API deployment entity.", + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentListResult": { + "type": "object", + "description": "The response of a Deployment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Deployment items on this page", + "items": { + "$ref": "#/definitions/Deployment" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DeploymentProperties": { + "type": "object", + "description": "API deployment entity properties.", + "properties": { + "title": { + "type": "string", + "description": "API deployment title", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Description of the deployment.", + "maxLength": 500 + }, + "environmentId": { + "type": "string", + "description": "API center-scoped environment resource ID." + }, + "definitionId": { + "type": "string", + "description": "API center-scoped definition resource ID." + }, + "state": { + "$ref": "#/definitions/DeploymentState", + "description": "State of API deployment." + }, + "server": { + "$ref": "#/definitions/DeploymentServer", + "description": "The deployment server" + }, + "customProperties": { + "$ref": "#/definitions/CustomProperties", + "description": "The custom metadata defined for API catalog entities." + } + } + }, + "DeploymentServer": { + "type": "object", + "description": "Server", + "properties": { + "runtimeUri": { + "type": "array", + "description": "Base runtime URLs for this deployment.", + "items": { + "$ref": "#/definitions/SmallString" + } + } + } + }, + "DeploymentState": { + "type": "string", + "description": "State of the Deployment", + "enum": [ + "active", + "inactive" + ], + "x-ms-enum": { + "name": "DeploymentState", + "modelAsString": true, + "values": [ + { + "name": "active", + "value": "active", + "description": "Active State" + }, + { + "name": "inactive", + "value": "inactive", + "description": "Inactive State" + } + ] + } + }, + "Environment": { + "type": "object", + "description": "Environment entity.", + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EnvironmentKind": { + "type": "string", + "description": "The kind of environment", + "enum": [ + "development", + "testing", + "staging", + "production" + ], + "x-ms-enum": { + "name": "EnvironmentKind", + "modelAsString": true, + "values": [ + { + "name": "development", + "value": "development", + "description": "Development environment" + }, + { + "name": "testing", + "value": "testing", + "description": "Testing environment" + }, + { + "name": "staging", + "value": "staging", + "description": "Staging environment" + }, + { + "name": "production", + "value": "production", + "description": "Production environment" + } + ] + } + }, + "EnvironmentListResult": { + "type": "object", + "description": "The response of a Environment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Environment items on this page", + "items": { + "$ref": "#/definitions/Environment" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "EnvironmentProperties": { + "type": "object", + "description": "Environment properties entity.", + "properties": { + "title": { + "type": "string", + "description": "Environment title.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The environment description." + }, + "kind": { + "$ref": "#/definitions/EnvironmentKind", + "description": "Environment kind." + }, + "server": { + "$ref": "#/definitions/EnvironmentServer", + "description": "Server information of the environment." + }, + "onboarding": { + "$ref": "#/definitions/Onboarding", + "description": "Environment onboarding information" + }, + "customProperties": { + "$ref": "#/definitions/CustomProperties", + "description": "The custom metadata defined for API catalog entities." + } + }, + "required": [ + "title", + "kind" + ] + }, + "EnvironmentServer": { + "type": "object", + "description": "Server information of the environment.", + "properties": { + "type": { + "$ref": "#/definitions/EnvironmentServerType", + "description": "Type of the server that represents the environment." + }, + "managementPortalUri": { + "type": "array", + "description": "The location of the management portal", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + }, + "EnvironmentServerType": { + "type": "string", + "description": "The type of environment server", + "enum": [ + "Azure API Management", + "Azure compute service", + "Apigee API Management", + "AWS API Gateway", + "Kong API Gateway", + "Kubernetes", + "MuleSoft API Management" + ], + "x-ms-enum": { + "name": "EnvironmentServerType", + "modelAsString": true, + "values": [ + { + "name": "Azure API Management", + "value": "Azure API Management", + "description": "Api Management Server" + }, + { + "name": "Azure compute service", + "value": "Azure compute service", + "description": "Compute server" + }, + { + "name": "Apigee API Management", + "value": "Apigee API Management", + "description": "Apigee server" + }, + { + "name": "AWS API Gateway", + "value": "AWS API Gateway", + "description": "AWS Api Gateway server" + }, + { + "name": "Kong API Gateway", + "value": "Kong API Gateway", + "description": "Kong API Gateway server" + }, + { + "name": "Kubernetes", + "value": "Kubernetes", + "description": "Kubernetes server" + }, + { + "name": "MuleSoft API Management", + "value": "MuleSoft API Management", + "description": "Mulesoft Api Management server" + } + ] + } + }, + "ExternalDocumentation": { + "type": "object", + "description": "Additional, external documentation for the API.", + "properties": { + "title": { + "type": "string", + "description": "Title of the documentation.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Description of the documentation.", + "maxLength": 500 + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL pointing to the documentation.", + "maxLength": 200 + } + }, + "required": [ + "url" + ] + }, + "ImportFromApimRequest": { + "type": "object", + "description": "The import from Azure API Management request.", + "properties": { + "sourceResourceIds": { + "type": "array", + "description": "An entity the metadata schema is requested for.", + "items": { + "type": "string" + } + } + } + }, + "ImportFromApimSuccessResult": { + "type": "object", + "description": "The import operation was successfully completed.", + "properties": { + "status": { + "type": "string", + "description": "Async operation status." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Async operation start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Async operation end time." + } + }, + "required": [ + "status", + "startTime" + ] + }, + "License": { + "type": "object", + "description": "The license information for the API.", + "properties": { + "name": { + "type": "string", + "description": "Name of the license.", + "maxLength": 100 + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL pointing to the license details. The URL field is mutually exclusive of the\nidentifier field.", + "maxLength": 200 + }, + "identifier": { + "type": "string", + "format": "uri", + "description": "SPDX license information for the API. The identifier field is mutually\nexclusive of the URL field.", + "maxLength": 50 + } + } + }, + "LifecycleStage": { + "type": "string", + "description": "The stage of the Api development lifecycle", + "enum": [ + "design", + "development", + "testing", + "preview", + "production", + "deprecated", + "retired" + ], + "x-ms-enum": { + "name": "LifecycleStage", + "modelAsString": true, + "values": [ + { + "name": "design", + "value": "design", + "description": "design stage" + }, + { + "name": "development", + "value": "development", + "description": "development stage" + }, + { + "name": "testing", + "value": "testing", + "description": "testing stage" + }, + { + "name": "preview", + "value": "preview", + "description": "In preview" + }, + { + "name": "production", + "value": "production", + "description": "In production" + }, + { + "name": "deprecated", + "value": "deprecated", + "description": "deprecated stage" + }, + { + "name": "retired", + "value": "retired", + "description": "Retired stage" + } + ] + } + }, + "LinkState": { + "type": "object", + "description": "The link state.", + "properties": { + "state": { + "type": "string", + "description": "The state of the link." + }, + "message": { + "type": "string", + "description": "The state message." + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update of the link state." + } + }, + "required": [ + "lastUpdatedOn" + ] + }, + "ManagedServiceIdentityType": { + "type": "string", + "description": "The type of managed service identity", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No identity" + }, + { + "name": "SystemAssigned", + "value": "SystemAssigned", + "description": "Assigned by the system" + }, + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "assigned by the user" + }, + { + "name": "SystemAssigned,UserAssigned", + "value": "SystemAssigned,UserAssigned", + "description": "Both system-assigned and user-assigned identities" + } + ] + } + }, + "MetadataAssignment": { + "type": "object", + "description": "Assignment metadata", + "properties": { + "entity": { + "$ref": "#/definitions/MetadataAssignmentEntity", + "description": "The entities this metadata schema component gets applied to." + }, + "required": { + "type": "boolean", + "description": "Required assignment" + }, + "deprecated": { + "type": "boolean", + "description": "Deprecated assignment" + } + } + }, + "MetadataAssignmentEntity": { + "type": "string", + "description": "Assignment entity for Metadata", + "enum": [ + "api", + "environment", + "deployment" + ], + "x-ms-enum": { + "name": "MetadataAssignmentEntity", + "modelAsString": true, + "values": [ + { + "name": "api", + "value": "api", + "description": "Assigned to API" + }, + { + "name": "environment", + "value": "environment", + "description": "Assigned to Environment" + }, + { + "name": "deployment", + "value": "deployment", + "description": "Assigned to Deployment" + } + ] + } + }, + "MetadataSchema": { + "type": "object", + "description": "Metadata schema entity. Used to define metadata for the entities in API catalog.", + "properties": { + "properties": { + "$ref": "#/definitions/MetadataSchemaProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "MetadataSchemaExportFormat": { + "type": "string", + "description": "The format for schema export", + "enum": [ + "inline", + "link" + ], + "x-ms-enum": { + "name": "MetadataSchemaExportFormat", + "modelAsString": true, + "values": [ + { + "name": "inline", + "value": "inline", + "description": "The inlined content of a schema document." + }, + { + "name": "link", + "value": "link", + "description": "The link to a schema document. The URL is valid for 5 minutes." + } + ] + } + }, + "MetadataSchemaExportRequest": { + "type": "object", + "description": "The metadata schema export request.", + "properties": { + "assignedTo": { + "$ref": "#/definitions/MetadataAssignmentEntity", + "description": "An entity the metadata schema is requested for." + } + } + }, + "MetadataSchemaExportResult": { + "type": "object", + "description": "The metadata schema export result.", + "properties": { + "format": { + "$ref": "#/definitions/MetadataSchemaExportFormat", + "description": "The export format for the schema" + }, + "value": { + "type": "string", + "description": "The result of the export operation." + } + } + }, + "MetadataSchemaListResult": { + "type": "object", + "description": "The response of a MetadataSchema list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MetadataSchema items on this page", + "items": { + "$ref": "#/definitions/MetadataSchema" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "MetadataSchemaProperties": { + "type": "object", + "description": "Metadata schema properties.", + "properties": { + "schema": { + "type": "string", + "description": "The schema defining the type." + }, + "assignedTo": { + "type": "array", + "description": "The assignees", + "items": { + "$ref": "#/definitions/MetadataAssignment" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "schema" + ] + }, + "Onboarding": { + "type": "object", + "description": "Onboarding information", + "properties": { + "instructions": { + "type": "string", + "description": "Onboarding guide." + }, + "developerPortalUri": { + "type": "array", + "description": "The location of the development portal", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + }, + "Origin": { + "type": "string", + "description": "The expected types of origin", + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true, + "values": [ + { + "name": "user", + "value": "user", + "description": "Origin with User" + }, + { + "name": "system", + "value": "system", + "description": "Origin with System" + }, + { + "name": "user,system", + "value": "user,system", + "description": "Origin with user and system" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of the resource", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "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." + } + ] + }, + "readOnly": true + }, + "Service": { + "type": "object", + "description": "The service entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceProperties", + "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" + } + ] + }, + "ServiceListResult": { + "type": "object", + "description": "The response of a Service list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Service items on this page", + "items": { + "$ref": "#/definitions/Service" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "ServiceProperties": { + "type": "object", + "description": "The properties of the service.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the service.", + "readOnly": true + }, + "restore": { + "type": "boolean", + "description": "Flag used to restore soft-deleted API Center service. If specified and set to 'true' all other properties will be ignored.", + "default": false + } + } + }, + "ServiceUpdate": { + "type": "object", + "description": "The type used for update operations of the Service.", + "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/ServiceUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "ServiceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Service.", + "properties": { + "restore": { + "type": "boolean", + "description": "Flag used to restore soft-deleted API Center service. If specified and set to 'true' all other properties will be ignored.", + "default": false + } + } + }, + "ShouldImportSpec": { + "type": "string", + "description": "The API source specification import options.", + "enum": [ + "never", + "ondemand", + "always" + ], + "x-ms-enum": { + "name": "ShouldImportSpec", + "modelAsString": true, + "values": [ + { + "name": "Never", + "value": "never", + "description": "Indicates that the specification should be never be imported." + }, + { + "name": "OnDemand", + "value": "ondemand", + "description": "Indicates that the specification should be imported only by request." + }, + { + "name": "Always", + "value": "always", + "description": "Indicates that the specification should always be imported along with metadata." + } + ] + } + }, + "SmallString": { + "type": "string", + "format": "uri", + "description": "Used for restricted length uris", + "maxLength": 200 + }, + "TermsOfService": { + "type": "object", + "description": "Terms of service for the API.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "URL pointing to the terms of service.", + "maxLength": 200 + } + }, + "required": [ + "url" + ] + }, + "Workspace": { + "type": "object", + "description": "Workspace entity.", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WorkspaceListResult": { + "type": "object", + "description": "The response of a Workspace list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Workspace items on this page", + "items": { + "$ref": "#/definitions/Workspace" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "WorkspaceProperties": { + "type": "object", + "description": "Workspace properties.", + "properties": { + "title": { + "type": "string", + "description": "Workspace title.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Workspace description." + } + }, + "required": [ + "title" + ] + } + }, + "parameters": { + "OdataFilterParameter": { + "name": "$filter", + "in": "query", + "description": "OData filter parameter.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "filter" + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_CreateOrUpdate.json new file mode 100644 index 000000000000..8e6196d9f481 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "operationId": "ApiDefinitions_CreateOrUpdate", + "title": "ApiDefinitions_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "openapi", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "OpenAPI", + "description": "Default spec" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Delete.json new file mode 100644 index 000000000000..f639680ef8e0 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "ApiDefinitions_Delete", + "title": "ApiDefinitions_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ExportSpecification.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ExportSpecification.json new file mode 100644 index 000000000000..3821c5b27370 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ExportSpecification.json @@ -0,0 +1,27 @@ +{ + "operationId": "ApiDefinitions_ExportSpecification", + "title": "ApiDefinitions_ExportSpecification", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "format": "inline", + "value": "{ ... }" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Get.json new file mode 100644 index 000000000000..310aab091534 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Get.json @@ -0,0 +1,35 @@ +{ + "operationId": "ApiDefinitions_Get", + "title": "ApiDefinitions_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Head.json new file mode 100644 index 000000000000..38be8965d8a5 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_Head.json @@ -0,0 +1,21 @@ +{ + "operationId": "ApiDefinitions_Head", + "title": "ApiDefinitions_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ImportSpecification.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ImportSpecification.json new file mode 100644 index 000000000000..e5b9fc19fee7 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_ImportSpecification.json @@ -0,0 +1,30 @@ +{ + "operationId": "ApiDefinitions_ImportSpecification", + "title": "ApiDefinitions_ImportSpecification", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "definitionName": "openapi", + "api-version": "2024-06-01-preview", + "payload": { + "format": "link", + "value": "https://...", + "specification": { + "name": "openapi", + "version": "3.0.1" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_List.json new file mode 100644 index 000000000000..04153e2eaf5b --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiDefinitions_List.json @@ -0,0 +1,38 @@ +{ + "operationId": "ApiDefinitions_List", + "title": "ApiDefinitions_ListByApiVersion", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/apis/versions/definitions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "name": "openapi", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "OpenAPI", + "description": "Default spec", + "specification": { + "name": "openapi", + "version": "3.0.6" + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_CreateOrUpdate.json new file mode 100644 index 000000000000..a23ee34372a2 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "operationId": "ApiSources_CreateOrUpdate", + "title": "ApiSources_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview", + "resource": { + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Delete.json new file mode 100644 index 000000000000..d91435f5223b --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "ApiSources_Delete", + "title": "ApiSources_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Get.json new file mode 100644 index 000000000000..43267d3cda65 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Get.json @@ -0,0 +1,32 @@ +{ + "operationId": "ApiSources_Get", + "title": "ApiSources_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Head.json new file mode 100644 index 000000000000..3ff2902a3cfe --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "ApiSources_Head", + "title": "ApiSources_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiSourceName": "contoso-api-management", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_List.json new file mode 100644 index 000000000000..3e9148d8e2fc --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiSources_List.json @@ -0,0 +1,35 @@ +{ + "operationId": "ApiSources_List", + "title": "ApiSources_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apiSources/contoso-api-management", + "type": "Microsoft.ApiCenter/services/workspaces/apiSources", + "name": "contoso-api-management", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "apimSource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso", + "msiResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity" + }, + "shouldImportSpec": "ondemand" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_CreateOrUpdate.json new file mode 100644 index 000000000000..11d685148fd1 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "operationId": "ApiVersions_CreateOrUpdate", + "title": "ApiVersions_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Delete.json new file mode 100644 index 000000000000..d8ef640547e7 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "ApiVersions_Delete", + "title": "ApiVersions_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Get.json new file mode 100644 index 000000000000..7ccc2967ceea --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Get.json @@ -0,0 +1,30 @@ +{ + "operationId": "ApiVersions_Get", + "title": "ApiVersions_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/apis/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "2023-01-01", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Head.json new file mode 100644 index 000000000000..ffe65fb200ad --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_Head.json @@ -0,0 +1,20 @@ +{ + "operationId": "ApiVersions_Head", + "title": "ApiVersions_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "versionName": "2023-01-01", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_List.json new file mode 100644 index 000000000000..d5b2c50029e3 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/ApiVersions_List.json @@ -0,0 +1,33 @@ +{ + "operationId": "ApiVersions_List", + "title": "ApiVersions_ListByApi", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "2023-01-01", + "lifecycleStage": "production" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_CreateOrUpdate.json new file mode 100644 index 000000000000..389af0578131 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_CreateOrUpdate.json @@ -0,0 +1,101 @@ +{ + "operationId": "Apis_CreateOrUpdate", + "title": "Apis_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Delete.json new file mode 100644 index 000000000000..aa7a6ee86277 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "Apis_Delete", + "title": "Apis_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Get.json new file mode 100644 index 000000000000..3a61e9abb1fd --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Get.json @@ -0,0 +1,46 @@ +{ + "operationId": "Apis_Get", + "title": "Apis_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Head.json new file mode 100644 index 000000000000..509a03573e64 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "Apis_Head", + "title": "Apis_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_List.json new file mode 100644 index 000000000000..219c88c1d100 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Apis_List.json @@ -0,0 +1,49 @@ +{ + "operationId": "Apis_List", + "title": "Apis_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api", + "name": "echo-api", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Echo API", + "description": "A simple HTTP request/response service.", + "lifecycleStage": "design", + "kind": "rest", + "termsOfService": { + "url": "https://contoso.com/terms-of-service" + }, + "license": { + "url": "https://contoso.com/license" + }, + "externalDocumentation": [ + { + "title": "Onboarding docs", + "url": "https://docs.contoso.com" + } + ], + "customProperties": { + "author": "John Doe" + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Delete.json new file mode 100644 index 000000000000..d1c62c1379a6 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Delete.json @@ -0,0 +1,14 @@ +{ + "title": "DeletedServices_Delete", + "operationId": "DeletedServices_Delete", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources", + "deletedServiceName": "contoso" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Get.json new file mode 100644 index 000000000000..ddb64b6711ad --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_Get.json @@ -0,0 +1,23 @@ +{ + "title": "DeletedServices_Get", + "operationId": "DeletedServices_Get", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources", + "deletedServiceName": "contoso" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "name": "contoso", + "type": "Microsoft.ApiCenter/deletedServices", + "properties": { + "softDeletionDate": "2024-03-01T22:15:58.348Z", + "scheduledPurgeDate": "2024-05-01T22:15:58.348Z" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_List.json new file mode 100644 index 000000000000..030a12540fd9 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_List.json @@ -0,0 +1,26 @@ +{ + "title": "DeletedServices_ListBySubscription", + "operationId": "DeletedServices_ListBySubscription", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "name": "contoso", + "type": "Microsoft.ApiCenter/deletedServices", + "properties": { + "softDeletionDate": "2024-03-01T22:15:58.348Z", + "scheduledPurgeDate": "2024-05-01T22:15:58.348Z" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_ListBySubscription.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_ListBySubscription.json new file mode 100644 index 000000000000..8e0f6d95ba45 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/DeletedServices_ListBySubscription.json @@ -0,0 +1,26 @@ +{ + "title": "DeletedServices_List", + "operationId": "DeletedServices_List", + "parameters": { + "api-version": "2024-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-resources" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "name": "contoso", + "type": "Microsoft.ApiCenter/deletedServices", + "properties": { + "softDeletionDate": "2024-03-01T22:15:58.348Z", + "scheduledPurgeDate": "2024-05-01T22:15:58.348Z" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_CreateOrUpdate.json new file mode 100644 index 000000000000..4faf4937b6c6 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_CreateOrUpdate.json @@ -0,0 +1,75 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "production", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "production", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Delete.json new file mode 100644 index 000000000000..38a836904741 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Delete.json @@ -0,0 +1,17 @@ +{ + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Get.json new file mode 100644 index 000000000000..92b990535d12 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Get.json @@ -0,0 +1,38 @@ +{ + "operationId": "Deployments_Get", + "title": "Deployments_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Production deployment", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Head.json new file mode 100644 index 000000000000..8002bc97fb88 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_Head.json @@ -0,0 +1,20 @@ +{ + "operationId": "Deployments_Head", + "title": "Deployments_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "deploymentName": "production", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_List.json new file mode 100644 index 000000000000..207f249349ae --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Deployments_List.json @@ -0,0 +1,41 @@ +{ + "operationId": "Deployments_List", + "title": "Deployments_ListByApi", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "apiName": "echo-api", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/apis/deployments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/deployments/production", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Development", + "description": "Public cloud production deployment.", + "environmentId": "/workspaces/default/environments/production", + "definitionId": "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi", + "state": "active", + "server": { + "runtimeUri": [ + "https://api.contoso.com" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_CreateOrUpdate.json new file mode 100644 index 000000000000..23bd4c08fbbc --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "operationId": "Environments_CreateOrUpdate", + "title": "Environments_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/environments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces/environments", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso" + ] + }, + "onboarding": { + "instructions": "Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.", + "developerPortalUri": [ + "https://developer.contoso.com" + ] + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Delete.json new file mode 100644 index 000000000000..66eea3aa7ef2 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "Environments_Delete", + "title": "Environments_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Get.json new file mode 100644 index 000000000000..64e29b1bc4af --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Get.json @@ -0,0 +1,37 @@ +{ + "operationId": "Environments_Get", + "title": "Environments_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Public", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [] + }, + "onboarding": { + "developerPortalUri": [] + }, + "customProperties": {} + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Head.json new file mode 100644 index 000000000000..4683f68e3e5e --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_Head.json @@ -0,0 +1,19 @@ +{ + "operationId": "Environments_Head", + "title": "Environments_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "environmentName": "public", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_List.json new file mode 100644 index 000000000000..5f27f0e36105 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Environments_List.json @@ -0,0 +1,41 @@ +{ + "operationId": "Environments_List", + "title": "Environments_ListByWorkspace", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/environments", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/environments/public", + "name": "public", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "Contoso Europe Azure API Management", + "description": "The primary Azure API Management service for the European division of Contoso.", + "kind": "production", + "server": { + "type": "Azure API Management", + "managementPortalUri": [] + }, + "onboarding": { + "developerPortalUri": [] + }, + "customProperties": {} + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_CreateOrUpdate.json new file mode 100644 index 000000000000..fd8f3036db04 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "operationId": "MetadataSchemas_CreateOrUpdate", + "title": "MetadataSchemas_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "metadataSchemaName": "author", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Delete.json new file mode 100644 index 000000000000..e2a29fd50627 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "MetadataSchemas_Delete", + "title": "MetadataSchemas_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "author", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Get.json new file mode 100644 index 000000000000..7343cc0d9af4 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Get.json @@ -0,0 +1,33 @@ +{ + "operationId": "MetadataSchemas_Get", + "title": "MetadataSchemas_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "lastName", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Head.json new file mode 100644 index 000000000000..8e1547a601a0 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_Head.json @@ -0,0 +1,18 @@ +{ + "operationId": "MetadataSchemas_Head", + "title": "MetadataSchemas_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "metadataSchemaName": "author", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_List.json new file mode 100644 index 000000000000..de67904b474d --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/MetadataSchemas_List.json @@ -0,0 +1,36 @@ +{ + "operationId": "MetadataSchemas_List", + "title": "MetadataSchemas_ListByService", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/metadataSchemas", + "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author", + "name": "author", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "assignedTo": [ + { + "entity": "api", + "deprecated": true + } + ], + "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Operations_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..9f3cd174dfef --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "List Provider Operations", + "parameters": { + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ApiCenter/services/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.ApiCenter", + "resource": "services", + "operation": "Lists services", + "description": "Lists registered services" + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_CreateOrUpdate.json new file mode 100644 index 000000000000..18cd690e4082 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "operationId": "Services_CreateOrUpdate", + "title": "Services_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview", + "resource": { + "properties": {}, + "tags": {}, + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Delete.json new file mode 100644 index 000000000000..b3e88494bd6d --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "Services_Delete", + "title": "Services_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ExportMetadataSchema.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ExportMetadataSchema.json new file mode 100644 index 000000000000..594020f67661 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ExportMetadataSchema.json @@ -0,0 +1,27 @@ +{ + "operationId": "Services_ExportMetadataSchema", + "title": "Services_ExportMetadataSchema", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "assignedTo": "api", + "api-version": "2024-06-01-preview", + "payload": { + "assignedTo": "api" + } + }, + "responses": { + "200": { + "body": { + "format": "json-schema", + "value": "{\"type\":\"object\",\"properties\":{ ... }}" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Get.json new file mode 100644 index 000000000000..7409fd533af7 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Get.json @@ -0,0 +1,35 @@ +{ + "operationId": "Services_Get", + "title": "Services_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ImportFromApim.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ImportFromApim.json new file mode 100644 index 000000000000..fe7388dee05a --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ImportFromApim.json @@ -0,0 +1,29 @@ +{ + "operationId": "Services_ImportFromApim", + "title": "Services_ImportFromApim", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview", + "body": { + "sourceResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso/apis/echo-api" + ] + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "startTime": "2024-10-23T19:49:30.6298125+00:00", + "endTime": "2024-10-23T19:49:50.3781596+00:00" + } + }, + "202": { + "headers": { + "location": "https://..." + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListByResourceGroup.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListByResourceGroup.json new file mode 100644 index 000000000000..0f3cb4abcb27 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "operationId": "Services_ListByResourceGroup", + "title": "Services_ListByResourceGroup", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListBySubscription.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListBySubscription.json new file mode 100644 index 000000000000..4345d15ef235 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_ListBySubscription.json @@ -0,0 +1,38 @@ +{ + "operationId": "Services_ListBySubscription", + "title": "Services_ListBySubscription", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + ] + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Update.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Update.json new file mode 100644 index 000000000000..e2b72ad9fadb --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Services_Update.json @@ -0,0 +1,44 @@ +{ + "operationId": "Services_Update", + "title": "Services_Update", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview", + "payload": { + "tags": {}, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso", + "type": "Microsoft.ApiCenter/services", + "name": "contoso", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "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" + } + } + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_CreateOrUpdate.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_CreateOrUpdate.json new file mode 100644 index 000000000000..bf99b85e459b --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspaces_CreateOrUpdate", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview", + "payload": { + "properties": { + "title": "default" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Delete.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Delete.json new file mode 100644 index 000000000000..91b771e83d36 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Workspaces_Delete", + "title": "Workspaces_Delete", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Get.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Get.json new file mode 100644 index 000000000000..ae32244ce106 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Get.json @@ -0,0 +1,27 @@ +{ + "operationId": "Workspaces_Get", + "title": "Workspaces_Get", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Head.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Head.json new file mode 100644 index 000000000000..d8873512ff48 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_Head.json @@ -0,0 +1,18 @@ +{ + "operationId": "Workspaces_Head", + "title": "Workspaces_Head", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "workspaceName": "default", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} diff --git a/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_List.json b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_List.json new file mode 100644 index 000000000000..e0a565e13226 --- /dev/null +++ b/specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2024-06-01-preview/examples/Workspaces_List.json @@ -0,0 +1,30 @@ +{ + "operationId": "Workspaces_List", + "title": "Workspaces_ListByService", + "parameters": { + "resourceGroupName": "contoso-resources", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "serviceName": "contoso", + "api-version": "2024-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ApiCenter/services/workspaces", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default", + "name": "default", + "systemData": { + "createdAt": "2023-07-03T18:27:09.128871Z", + "lastModifiedAt": "2023-07-03T18:27:09.1288716Z" + }, + "properties": { + "title": "default" + } + } + ] + } + } + } +} 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 c33916a2bc68..cc8bcbb3b4dd 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 @@ -3765,6 +3765,36 @@ "lifecycleStage" ] }, + "ApimSource": { + "type": "object", + "description": "API source configuration for Azure API Management.", + "properties": { + "resourceId": { + "type": "string", + "description": "API Management service resource ID." + }, + "msiResourceId": { + "type": "string", + "description": "The resource ID of the managed identity that has access to the API Management instance." + }, + "targetEnvironmentId": { + "type": "string", + "description": "The target environment resource ID." + }, + "targetLifecycleStage": { + "$ref": "#/definitions/LifecycleStage", + "description": "The target lifecycle stage." + }, + "linkState": { + "$ref": "#/definitions/LinkState", + "description": "The state of the API source link", + "readOnly": true + } + }, + "required": [ + "resourceId" + ] + }, "Contact": { "type": "object", "description": "Contact information", @@ -4226,6 +4256,28 @@ ] } }, + "LinkState": { + "type": "object", + "description": "The link state.", + "properties": { + "state": { + "type": "string", + "description": "The state of the link." + }, + "message": { + "type": "string", + "description": "The state message." + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update of the link state." + } + }, + "required": [ + "lastUpdatedOn" + ] + }, "ManagedServiceIdentityType": { "type": "string", "description": "The type of managed service identity", diff --git a/specification/apicenter/resource-manager/readme.md b/specification/apicenter/resource-manager/readme.md index 4ef3ed0a292e..193887686df0 100644 --- a/specification/apicenter/resource-manager/readme.md +++ b/specification/apicenter/resource-manager/readme.md @@ -27,7 +27,16 @@ These are the global settings for the Azure API Center. ``` yaml openapi-type: arm openapi-subtype: providerHub -tag: package-2024-03-15-preview +tag: package-2024-06-01-preview +``` + +### 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: + - Microsoft.ApiCenter/preview/2024-06-01-preview/apicenter.json ``` ### Tag: package-2024-03-15-preview