From 775b4ba0f29803f20821f1c3a63cdcf34f6944d2 Mon Sep 17 00:00:00 2001 From: mmorr-msft <51933005+mmorr-msft@users.noreply.github.com> Date: Fri, 31 May 2024 07:02:17 -0700 Subject: [PATCH] Create Mircosoft.VerifiedId Resource Provider public preview (#28933) * copy verifiedid from private * fix latest style rules * rerun validate * change key name * re-run local validation * update examples * manually fix generated docs * trying to make it pass validation, local validation won't run * maybe fixed? * fix lists? --- .../Authorities_CreateOrUpdate.json | 36 ++ .../Authorities_Delete.json | 14 + .../2024-01-26-preview/Authorities_Get.json | 22 + .../Authorities_ListByResourceGroup.json | 31 ++ .../Authorities_ListBySubscription.json | 30 ++ .../Authorities_Update.json | 23 + .../2024-01-26-preview/Operations_List.json | 28 + .../verifiedid/Microsoft.VerifiedId/main.tsp | 79 +++ .../Microsoft.VerifiedId/tspconfig.yaml | 12 + .../examples/Authorities_CreateOrUpdate.json | 36 ++ .../examples/Authorities_Delete.json | 14 + .../examples/Authorities_Get.json | 22 + .../Authorities_ListByResourceGroup.json | 31 ++ .../Authorities_ListBySubscription.json | 30 ++ .../examples/Authorities_Update.json | 23 + .../examples/Operations_List.json | 28 + .../2024-01-26-preview/verifiedid.json | 508 ++++++++++++++++++ .../verifiedid/resource-manager/readme.az.md | 28 + .../verifiedid/resource-manager/readme.cli.md | 1 + .../resource-manager/readme.csharp.md | 15 + .../verifiedid/resource-manager/readme.go.md | 11 + .../verifiedid/resource-manager/readme.md | 79 +++ .../resource-manager/readme.python.md | 23 + .../resource-manager/readme.typescript.md | 14 + 24 files changed, 1138 insertions(+) create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json create mode 100644 specification/verifiedid/Microsoft.VerifiedId/main.tsp create mode 100644 specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json create mode 100644 specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json create mode 100644 specification/verifiedid/resource-manager/readme.az.md create mode 100644 specification/verifiedid/resource-manager/readme.cli.md create mode 100644 specification/verifiedid/resource-manager/readme.csharp.md create mode 100644 specification/verifiedid/resource-manager/readme.go.md create mode 100644 specification/verifiedid/resource-manager/readme.md create mode 100644 specification/verifiedid/resource-manager/readme.python.md create mode 100644 specification/verifiedid/resource-manager/readme.typescript.md diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json new file mode 100644 index 000000000000..778cb01894ee --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "operationId": "Authorities_CreateOrUpdate", + "title": "CreateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "resource": { + "properties": {}, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json new file mode 100644 index 000000000000..bd8155a9c921 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "Authorities_Delete", + "title": "DeleteAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json new file mode 100644 index 000000000000..2d8394e5862f --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Get.json @@ -0,0 +1,22 @@ +{ + "operationId": "Authorities_Get", + "title": "GetAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json new file mode 100644 index 000000000000..181c8986ac08 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "title": "Authorities_ListByResourceGroup", + "operationId": "Authorities_ListByResourceGroup", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json new file mode 100644 index 000000000000..61840f59931f --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "title": "Authorities_ListBySubscription", + "operationId": "Authorities_ListBySubscription", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json new file mode 100644 index 000000000000..91403cf95deb --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Authorities_Update.json @@ -0,0 +1,23 @@ +{ + "operationId": "Authorities_Update", + "title": "UpdateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json new file mode 100644 index 000000000000..09854063c45a --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/examples/2024-01-26-preview/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-01-26-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VerifiedId/Authorities/read", + "isDataAction": true, + "display": { + "provider": "Microsoft.VerifiedId", + "resource": "Authorities", + "operation": "read", + "description": "Read the Authority resources for the Verified ID service." + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/operations?api-version=2024-01-26-preview" + } + } + } +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/main.tsp b/specification/verifiedid/Microsoft.VerifiedId/main.tsp new file mode 100644 index 000000000000..01f85aabab69 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/main.tsp @@ -0,0 +1,79 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +@armProviderNamespace("Microsoft.VerifiedId") +@service({ + title: "VerifiedIdMgmtClient", +}) +@versioned(Microsoft.VerifiedId.Versions) +@doc("VerifiedId Resource Provider management API.") +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.VerifiedId; + +/** + * Supported versions for Microsoft.VerifiedId. + */ +enum Versions { + /** + * The 2024-01-26-preview version of the Microsoft.VerifiedId resource provider. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + v2024_01_26_preview: "2024-01-26-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("A VerifiedId authority resource") +model Authority is TrackedResource { + @doc("The ID of the authority") + @pattern("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$") + @key("authorityName") + @segment("authorities") + @path + name: string; +} + +@doc("The status of the current operation.") +@Azure.Core.lroStatus +union ProvisioningState { + string, + ResourceProvisioningState, + + @doc("Initial provisioning in progress") + Provisioning: "Provisioning", + + @doc("Update in progress") + Updating: "Updating", + + @doc("Deletion in progress") + Deleting: "Deleting", + + @doc("Change accepted for processing") + Accepted: "Accepted", +} + +@doc("Details of the VerifiedId Authority.") +model AuthorityProperties { + @visibility("read") + @doc("The status of the last operation.") + provisioningState?: ProvisioningState; +} + +@armResourceOperations(Authority) +interface Authorities { + get is ArmResourceRead; + createOrUpdate is ArmResourceCreateOrReplaceAsync; + update is ArmResourcePatchSync; + delete is ArmResourceDeleteSync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; +} diff --git a/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml b/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml new file mode 100644 index 000000000000..055df028743e --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId/tspconfig.yaml @@ -0,0 +1,12 @@ +linter: + extends: + - "@azure-tools/typespec-azure-resource-manager/all" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "resource-manager" + emitter-output-dir: "{project-root}/.." + examples-directory: "examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/verifiedid.json" + use-read-only-status-schema: true diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json new file mode 100644 index 000000000000..778cb01894ee --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "operationId": "Authorities_CreateOrUpdate", + "title": "CreateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "resource": { + "properties": {}, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json new file mode 100644 index 000000000000..bd8155a9c921 --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Delete.json @@ -0,0 +1,14 @@ +{ + "operationId": "Authorities_Delete", + "title": "DeleteAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json new file mode 100644 index 000000000000..2d8394e5862f --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Get.json @@ -0,0 +1,22 @@ +{ + "operationId": "Authorities_Get", + "title": "GetAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json new file mode 100644 index 000000000000..181c8986ac08 --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "title": "Authorities_ListByResourceGroup", + "operationId": "Authorities_ListByResourceGroup", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json new file mode 100644 index 000000000000..61840f59931f --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "title": "Authorities_ListBySubscription", + "operationId": "Authorities_ListBySubscription", + "parameters": { + "api-version": "2024-01-26-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "centralus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "systemData": { + "createdBy": "ypsrynjsvwvcooacwzwb", + "createdByType": "User", + "createdAt": "2023-12-28T17:24:15.284Z", + "lastModifiedBy": "qlojlakxwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-12-28T17:24:15.284Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/authorities?api-version=2024-01-26-preview&$skiptoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json new file mode 100644 index 000000000000..91403cf95deb --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Authorities_Update.json @@ -0,0 +1,23 @@ +{ + "operationId": "Authorities_Update", + "title": "UpdateAuthority", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-01-26-preview", + "authorityName": "00000000-0000-0000-0000-000000000111", + "properties": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.VerifiedId/aurthorities/00000000-0000-0000-0000-000000000111", + "type": "Microsoft.VerifiedId/authorities", + "properties": { + "provisioningState": "Succeeded" + }, + "location": "westus" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json new file mode 100644 index 000000000000..09854063c45a --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-01-26-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VerifiedId/Authorities/read", + "isDataAction": true, + "display": { + "provider": "Microsoft.VerifiedId", + "resource": "Authorities", + "operation": "read", + "description": "Read the Authority resources for the Verified ID service." + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/operations?api-version=2024-01-26-preview" + } + } + } +} diff --git a/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json new file mode 100644 index 000000000000..a97a1e596f5e --- /dev/null +++ b/specification/verifiedid/resource-manager/Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json @@ -0,0 +1,508 @@ +{ + "swagger": "2.0", + "info": { + "title": "VerifiedIdMgmtClient", + "version": "2024-01-26-preview", + "description": "VerifiedId Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Authorities" + } + ], + "paths": { + "/providers/Microsoft.VerifiedId/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VerifiedId/authorities": { + "get": { + "operationId": "Authorities_ListBySubscription", + "tags": [ + "Authorities" + ], + "description": "List Authority resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorities_ListBySubscription": { + "$ref": "./examples/Authorities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VerifiedId/authorities": { + "get": { + "operationId": "Authorities_ListByResourceGroup", + "tags": [ + "Authorities" + ], + "description": "List Authority resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AuthorityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Authorities_ListByResourceGroup": { + "$ref": "./examples/Authorities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VerifiedId/authorities/{authorityName}": { + "get": { + "operationId": "Authorities_Get", + "tags": [ + "Authorities" + ], + "description": "Get a Authority", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Authority" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAuthority": { + "$ref": "./examples/Authorities_Get.json" + } + } + }, + "put": { + "operationId": "Authorities_CreateOrUpdate", + "tags": [ + "Authorities" + ], + "description": "Create a Authority", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Authority" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Authority' update operation succeeded", + "schema": { + "$ref": "#/definitions/Authority" + } + }, + "201": { + "description": "Resource 'Authority' create operation succeeded", + "schema": { + "$ref": "#/definitions/Authority" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateAuthority": { + "$ref": "./examples/Authorities_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Authorities_Update", + "tags": [ + "Authorities" + ], + "description": "Update a Authority", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorityUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Authority" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateAuthority": { + "$ref": "./examples/Authorities_Update.json" + } + } + }, + "delete": { + "operationId": "Authorities_Delete", + "tags": [ + "Authorities" + ], + "description": "Delete a Authority", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "authorityName", + "in": "path", + "description": "The ID of the authority", + "required": true, + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteAuthority": { + "$ref": "./examples/Authorities_Delete.json" + } + } + } + } + }, + "definitions": { + "Authority": { + "type": "object", + "description": "A VerifiedId authority resource", + "properties": { + "properties": { + "$ref": "#/definitions/AuthorityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AuthorityListResult": { + "type": "object", + "description": "The response of a Authority list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Authority items on this page", + "items": { + "$ref": "#/definitions/Authority" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AuthorityProperties": { + "type": "object", + "description": "Details of the VerifiedId Authority.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AuthorityUpdate": { + "type": "object", + "description": "The type used for update operations of the Authority.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Initial provisioning in progress" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Update in progress" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Change accepted for processing" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/verifiedid/resource-manager/readme.az.md b/specification/verifiedid/resource-manager/readme.az.md new file mode 100644 index 000000000000..57b0d9bc4e2d --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: verifiedid + namespace: azure.mgmt.verifiedid + package-name: azure-mgmt-verifiedid +az-output-folder: $(azure-cli-extension-folder)/src/verifiedid +python-sdk-output-folder: "$(az-output-folder)/azext_verifiedid/vendored_sdks/verifiedid" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: verifiedid + namespace: azure.mgmt.verifiedid + package-name: azure-mgmt-verifiedid +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/verifiedid +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/verifiedid" +``` \ No newline at end of file diff --git a/specification/verifiedid/resource-manager/readme.cli.md b/specification/verifiedid/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/verifiedid/resource-manager/readme.csharp.md b/specification/verifiedid/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..d69bdba6773b --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.VerifiedId + output-folder: $(csharp-sdks-folder)/verifiedid/management/Microsoft.VerifiedId/GeneratedProtocol +``` diff --git a/specification/verifiedid/resource-manager/readme.go.md b/specification/verifiedid/resource-manager/readme.go.md new file mode 100644 index 000000000000..aab65128a6cb --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/verifiedid/armverifiedid +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/verifiedid/resource-manager/readme.md b/specification/verifiedid/resource-manager/readme.md new file mode 100644 index 000000000000..1070721e810e --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.md @@ -0,0 +1,79 @@ +# verifiedid + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for verifiedid. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the verifiedid. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2024-01-26-preview +``` + +### Tag: package-2024-01-26-preview + +These settings apply only when `--tag=package-2024-01-26-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-01-26-preview' +input-file: + - Microsoft.VerifiedId/preview/2024-01-26-preview/verifiedid.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/verifiedid/resource-manager/readme.python.md b/specification/verifiedid/resource-manager/readme.python.md new file mode 100644 index 000000000000..b3819bde88e2 --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-verifiedid +namespace: azure.mgmt.verifiedid +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/verifiedid/azure-mgmt-verifiedid/azure/mgmt/verifiedid +``` + +``` yaml $(python) +modelerfour: + flatten-models: false +``` diff --git a/specification/verifiedid/resource-manager/readme.typescript.md b/specification/verifiedid/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..ad0cb1832ee1 --- /dev/null +++ b/specification/verifiedid/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-verifiedid" + output-folder: "$(typescript-sdks-folder)/sdk/verifiedid/arm-verifiedid" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +```